<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>WebCL: IWebCLProgram Interface Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">WebCL
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">IWebCLProgram Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="IWebCLProgram" -->
<p><a class="el" href="interfaceIWebCLProgram.html" title="IWebCLProgram interface abstracts a WebCL program.">IWebCLProgram</a> interface abstracts a WebCL program.  
 <a href="interfaceIWebCLProgram.html#details">More...</a></p>

<p><code>import &quot;<a class="el" href="IWebCLProgram_8idl_source.html">IWebCLProgram.idl</a>&quot;;</code></p>

<p><a href="interfaceIWebCLProgram-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#acf0558b0f91dac18a1f866971b4c9d36">getProgramInfo</a> (in long aName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get program info.  <a href="#acf0558b0f91dac18a1f866971b4c9d36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#a6dd18d64ffbef2eb5ffa5bd723b73363">getProgramBuildInfo</a> (in nsISupports aDevice, in long aName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get program build info.  <a href="#a6dd18d64ffbef2eb5ffa5bd723b73363"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#a476eca0aad82806162abe0bac5002f6d">buildProgram</a> (in nsIVariant aDevices, in string aOptions)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds (compiles and links) a program executable from the program source or binary.  <a href="#a476eca0aad82806162abe0bac5002f6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceIWebCLKernel.html">IWebCLKernel</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#ac04fa31683590f335e4b901ce1d5be87">createKernel</a> (in string aKernelName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a kernel object.  <a href="#ac04fa31683590f335e4b901ce1d5be87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#ae1ee85a07cd24b79d8df76d4348be449">createKernelsInProgram</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates kernel objects for all kernel functions in a program object.  <a href="#ae1ee85a07cd24b79d8df76d4348be449"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLProgram.html#a1b40f13e4f12b4c77ea6dc8fbf29f0c2">releaseCLResources</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Immediately releases all OpenCL-related resources if any are allocated for this object.  <a href="#a1b40f13e4f12b4c77ea6dc8fbf29f0c2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interfaceIWebCLProgram.html" title="IWebCLProgram interface abstracts a WebCL program.">IWebCLProgram</a> interface abstracts a WebCL program. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cl_program </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a476eca0aad82806162abe0bac5002f6d"></a><!-- doxytag: member="IWebCLProgram::buildProgram" ref="a476eca0aad82806162abe0bac5002f6d" args="(in nsIVariant aDevices, in string aOptions)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCLProgram.html#a476eca0aad82806162abe0bac5002f6d">IWebCLProgram::buildProgram</a> </td>
          <td>(</td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aDevices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in string&#160;</td>
          <td class="paramname"><em>aOptions</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Builds (compiles and links) a program executable from the program source or binary. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aDevices</td><td>Array of <a class="el" href="interfaceIWebCLDevice.html" title="IWebCLDevice interface abstracts a WebCL device.">IWebCLDevice</a> instances. </td></tr>
    <tr><td class="paramname">aOptions</td><td>A string that describes the build options to be used for building the program executable. </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clBuildProgram </dd></dl>

</div>
</div>
<a class="anchor" id="ac04fa31683590f335e4b901ce1d5be87"></a><!-- doxytag: member="IWebCLProgram::createKernel" ref="ac04fa31683590f335e4b901ce1d5be87" args="(in string aKernelName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interfaceIWebCLKernel.html">IWebCLKernel</a> <a class="el" href="interfaceIWebCLProgram.html#ac04fa31683590f335e4b901ce1d5be87">IWebCLProgram::createKernel</a> </td>
          <td>(</td>
          <td class="paramtype">in string&#160;</td>
          <td class="paramname"><em>aKernelName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates a kernel object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aKernelName</td><td>A function name in the program declared with the __kernel qualifier. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A WebCLKernel instance. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clCreateKernel </dd></dl>

</div>
</div>
<a class="anchor" id="ae1ee85a07cd24b79d8df76d4348be449"></a><!-- doxytag: member="IWebCLProgram::createKernelsInProgram" ref="ae1ee85a07cd24b79d8df76d4348be449" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCLProgram.html#ae1ee85a07cd24b79d8df76d4348be449">IWebCLProgram::createKernelsInProgram</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates kernel objects for all kernel functions in a program object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of <a class="el" href="interfaceIWebCLKernel.html" title="IWebCLKernel interface abstracts a WebCL kernel.">IWebCLKernel</a> instances. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clCreateKernelsInProgram </dd></dl>

</div>
</div>
<a class="anchor" id="a6dd18d64ffbef2eb5ffa5bd723b73363"></a><!-- doxytag: member="IWebCLProgram::getProgramBuildInfo" ref="a6dd18d64ffbef2eb5ffa5bd723b73363" args="(in nsISupports aDevice, in long aName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCLProgram.html#a6dd18d64ffbef2eb5ffa5bd723b73363">IWebCLProgram::getProgramBuildInfo</a> </td>
          <td>(</td>
          <td class="paramtype">in nsISupports&#160;</td>
          <td class="paramname"><em>aDevice</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get program build info. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aDevice</td><td>A WebCLDevice instance for which build information is being queried. Must be a valid device associated with the program instance. </td></tr>
    <tr><td class="paramname">aName</td><td>Name of the info parameter. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting value. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clGetProgramBuildInfo </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="acf0558b0f91dac18a1f866971b4c9d36"></a><!-- doxytag: member="IWebCLProgram::getProgramInfo" ref="acf0558b0f91dac18a1f866971b4c9d36" args="(in long aName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCLProgram.html#acf0558b0f91dac18a1f866971b4c9d36">IWebCLProgram::getProgramInfo</a> </td>
          <td>(</td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get program info. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aName</td><td>Name of the info parameter. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting value. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clGetProgramInfo </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="a1b40f13e4f12b4c77ea6dc8fbf29f0c2"></a><!-- doxytag: member="IWebCLProgram::releaseCLResources" ref="a1b40f13e4f12b4c77ea6dc8fbf29f0c2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCLProgram.html#a1b40f13e4f12b4c77ea6dc8fbf29f0c2">IWebCLProgram::releaseCLResources</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Immediately releases all OpenCL-related resources if any are allocated for this object. </p>
<p>The object should not be used anymore after calling this function. </p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>public/<a class="el" href="IWebCLProgram_8idl_source.html">IWebCLProgram.idl</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 7 2012 12:59:51 for WebCL by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
